home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / programming / c / c2man-2.0pl33.lha / c2man-2.0 / catalog < prev    next >
Encoding:
Text File  |  1995-01-24  |  2.2 KB  |  45 lines
  1. language:    C, nroff, texinfo, latex, html
  2. package:    c2man
  3. version:    2.0 patchlevel 32
  4. parts:        documentation generator (C -> nroff -man, -> texinfo, -> latex,
  5.         -> html)
  6. author:        Graham Stoney <greyham@research.canon.oz.au>
  7. location:    ftp from any comp.sources.misc archive, in volume42
  8.         (the version in the comp.sources.reviewed archive is obsolete)
  9.         ftp /pub/Unix/Util/c2man-2.0.*.tar.gz from dnpap.et.tudelft.nl
  10.     Australia:    ftp /usenet/comp.sources.misc/volume42/c2man-2.0/*
  11.         from archie.au
  12.     N.America:    ftp /usenet/comp.sources.misc/volume42/c2man-2.0/*
  13.         from ftp.wustl.edu
  14.     Europe:    ftp /News/comp.sources.misc/volume42/c2man-2.0/*
  15.         from ftp.irisa.fr
  16.     Japan:    ftp /pub/NetNews/comp.sources.misc/volume42/c2man-2.0/*
  17.         from ftp.iij.ad.jp
  18.     Patches:    ftp pub/netnews/sources.bugs/volume93/sep/c2man* from lth.se
  19. description:    c2man is an automatic documentation tool that extracts comments
  20.         from C source code to generate functional interface
  21.         documentation in the same format as sections 2 & 3 of the Unix
  22.         Programmer's Manual. It requires minimal effort from the
  23.         programmer by looking for comments in the usual places near the
  24.         objects they document, rather than imposing a rigid
  25.         function-comment syntax or requiring that the programmer learn
  26.         and use a typesetting language. Acceptable documentation can
  27.         often be generated from existing code with no modifications.
  28. conformance:    supports both K&R and ISO/ANSI C coding styles
  29. features:    + generates output in nroff -man, TeXinfo or LaTeX format
  30.         + handles comments as part of the language grammar
  31.         + automagically documents enum parameter & return values
  32.         + handles C (/* */) and C++ (//) style comments
  33.         - doesn't handle C++ grammar (yet)
  34. requires:    yacc/byacc/bison, lex/flex, and nroff/groff/texinfo/LaTeX.
  35. ports:        Unix, OS/2, MSDOS, VMS.
  36. portability:    very high for unix, via Configure
  37. status:        actively developed; contributions by users are encouraged.
  38. discussion:    via a mailing list: send "subscribe c2man <Your Name>" (in the
  39.         message body) to listserv@research.canon.oz.au
  40. help:        from the author and other users on the mailing list:
  41.         c2man@research.canon.oz.au
  42. announcements:    patches appear first in comp.sources.bugs, and then in
  43.         comp.sources.misc.
  44. updated:    1994/06/22
  45.